Skip to content

docs: consolidate README, cut repetitive sections - #128

Merged
parsakhaz merged 1 commit into
mainfrom
docs/consolidate-readme
Apr 11, 2026
Merged

parsakhaz merged 1 commit into
mainfrom
docs/consolidate-readme

Conversation

@parsakhaz

Copy link
Copy Markdown
Member

Summary

  • Replaces Two Core Primitives, The Integration Layer, and the 8-subsection Features grid with a single tighter How It Works section
  • Cuts Design Principles entirely (every bullet repeated content already stated in narrative form elsewhere)
  • Cuts Adding Custom Agents (outdated, per owner)
  • Retargets the top-of-README nav link that pointed at the removed #features anchor

Net: -55 lines, zero loss of unique content.

Test plan

  • Render on GitHub and confirm the new How It Works section flows after the comparison table
  • Confirm no broken anchor links at the top

Replaces "Two Core Primitives", "The Integration Layer", and the
"Features" grid (8 subsections) with a single tighter "How It Works"
section. Cuts "Design Principles" and "Adding Custom Agents" entirely,
since everything in Design Principles was already stated elsewhere and
the Custom Agents section was outdated. Also retargets the top nav
link that pointed at the removed Features section.
@parsakhaz
parsakhaz merged commit 4dd3fff into main Apr 11, 2026
1 check passed
@parsakhaz
parsakhaz deleted the docs/consolidate-readme branch April 11, 2026 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant